home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / arcmail.arc / ARCMAIL.DOC next >
Text File  |  1986-12-02  |  14KB  |  385 lines

  1.  
  2.                                ARCMAIL
  3.  
  4. |                            Version 0.60
  5.  
  6.  
  7.  
  8.     NOTICE:
  9.     -------
  10.  
  11.     As a courtesy of System Enhancement Associates,  there is now
  12.     a  utility  which  may be used to ARC and deARC mail packets.
  13. |   This utility is ARCmail version 0.60.  This is  not  a  fully
  14.     supported product, it is available on a "use as is" basis.
  15.  
  16.     We  do  not  promise  that  we will ever develop this concept
  17.     beyond this initial prototype  version.  But  this  does  not
  18.     mean that we will not support this program at all.
  19.  
  20.  
  21.                               * * * * *
  22.  
  23.     FEATURES:
  24.     ---------
  25.  
  26.     ARCmail  is  both  Fido and SEAdog compatible,  and should be
  27.     executed from either the Fido or SEAdog  root  directory.  It
  28.     can  be  executed  from  anywhere  if the SEADOG= environment
  29.     string has been set.
  30.  
  31.     ARCmail   automates   the   process   of   packetizing    and
  32.     depacketizing messages and ARCing and unARCing the packetized
  33.     messages.
  34.  
  35.     ARCmail  may be executed several times a day to packetize any
  36.     additional outgoing messages and to place them into  multiple
  37.     ARCmail  files  with unique names;  thus allowing you to send
  38.     multiple ARCmail files to the same destination  on  the  same
  39.     day.
  40.  
  41.     ARCmail generates and ARCs file with unique names between the
  42.     sender and receiver.
  43.  
  44.     ARCmail's  display output may be redirected to a file for the
  45.     purpose of maintaining an ARCmail log.
  46.  
  47.  
  48.                             * * * * *
  49.  
  50.     Creating an ARCed packet:
  51.     -------------------------
  52.  
  53.     ARCmail may be used to packetize and  compress  all  messages
  54.     destined to one or more nodes as follows:
  55.  
  56.             arcmail to 107/7 132/101
  57.  
  58.     This  would  cause  all  mail  addressed  to  either 107/7 or
  59.     132/101 to be packetized and archived,  with appropriate file
  60.     attach messages if necessary.
  61.  
  62.  
  63.     Thus  to  use  ARCmail with EchoMail,  the sender may use the
  64.     following:
  65.  
  66.             scanmail run -maxmsgs 2000 -short
  67.             arcmail to 107/7 107/16 107/312 100/76 132/101
  68.  
  69. |   ARCmail can also take a list of nodes in a file as follows:
  70.  
  71. |           arcmail to list nodes.lst
  72.  
  73. |   The format of the file is very simple.  Each  "word"  in  the
  74. |   file  is  examined  to  see  if  it  consists  of two numbers
  75. |   separated by a slash.  If it is,  then it is considered to be
  76. |   a network address to which mail should be archived.  If it is
  77. |   not,  then  it  is ignored.  No error messages are generated.
  78. |   Any given address may be listed multiple times  in  the  file
  79. |   without harm.  This is specifically designed to allow the use
  80. |   of an AREAS.BBS file as the list of nodes.
  81.  
  82. |   As an example,  a simple way to archive all outgoing echomail
  83. |   is to use the following:
  84.  
  85. |           scanmail run -short
  86. |           arcmail to list areas.bbs
  87.  
  88.  
  89.                               * * * * *
  90.  
  91.     Processing the ARCed packet:
  92.     ----------------------------
  93.  
  94.     The receiver may then decompress and depacketize all  his/her
  95.     messages as follows:
  96.  
  97.             arcmail from 107/312 132/101
  98.  
  99.  
  100.     Hence the receiver may use the  following  to  process  ARCed
  101.     EchoMail messages:
  102.  
  103.             arcmail from 107/7 107/16 107/312 100/76 132/101
  104.             tossmail run
  105.  
  106.  
  107. |   It  is also permissible,  though somewhat more risky,  to use
  108. |   the keyword "ALL".  This tells ARCmail to look  for  possible
  109. |   received  ARCmail  packets,  and  to  unpacket  all which are
  110. |   found.  An example would be:
  111.  
  112. |           arcmail from all
  113.  
  114. |   ARCmail will abort if it attempts to unpacket something which
  115. |   turns out not to be a mail archive.
  116.  
  117.  
  118.                               * * * * *
  119.  
  120.     Detecting unprocessed packets:
  121.     ------------------------------
  122.  
  123.     ARCmail is capable of detecting received mail  archives  that
  124.     have  not yet been unpacked.  To see who has sent you ARCmail
  125.     that you have not processed, you should use the following:
  126.  
  127.               arcmail from who
  128.  
  129.     The use of improper grammar in this  command  indicates  that
  130.     ARCmail  is less bright than it could be here.  The technique
  131.     used to detect unprocessed mail archives is fairly  reliable,
  132.     but not completely so.
  133.  
  134.     To  assist  in  writing  batch files,  the "who" option above
  135.     causes ARCmail to terminate with an error level equal to  the
  136.     number  of  possible  mail  archives found.  For example,  if
  137.     ARCmail detects three possible mail archives,  then  it  will
  138.     terminate with an error level of three.
  139.  
  140.  
  141.     Detecting created packets:
  142.     --------------------------
  143.  
  144.     ARCmail  is  capable  of  informing you of what outbound mail
  145.     packets you have, and who they were created for.  To see what
  146.     outbound mail packets exist, type:
  147.  
  148.               arcmail to who
  149.  
  150.     The use of improper grammar here indicates  less  than  total
  151.     reliability,  as  with  the  "from who" option.  All existing
  152.     outbound ARCmail packets are shown,  regardless of whether or
  153.     not they have been sent.
  154.  
  155.     Again,  as with the "from who" option, ARCmail will exit with
  156.     an error level equal to the number of possible mail  archives
  157. |   detected which are non-zero in length.
  158.  
  159.  
  160.                               * * * * *
  161.  
  162.     Naming conventions used:
  163.     ------------------------
  164.  
  165.     The  name  of  the  ARC  file  which  contains the ARCed mail
  166.     packets is:
  167.  
  168.          xxxxyyyy.wwc
  169.  
  170.     where:
  171.  
  172.          xxxx  ==  Net  number  of  sender  minus  net  number of
  173.                    receiver, as four hexadecimal digits.
  174.  
  175.          yyyy  ==  Node number  of  sender  minus  node number of
  176.                    receiver, as four hexadecimal digits.
  177.  
  178.            ww  ==  The  day of the week on which the mail archive
  179.                    was created (MO, TU, WE, TH, FR, SA, or SU).
  180.  
  181.             c  ==  The  relative  ARCmail  archive count for that
  182.                    day,  from 1 to 9.  ARCmail packets after  the
  183.                    first  nine  on  a  given  day  are  placed in
  184.                    archive number zero.
  185.  
  186.     For example,  if 107/312 creates a mail archive  for  137/19,
  187.     the mail archive name would be calculated as follows:
  188.  
  189.                                         Net            Node
  190.                                         ----           ----
  191.  
  192.          Sender                         107            312
  193.          Receiver                      -137            -19
  194.                                         ===            ===
  195.          Difference (decimal)           -30            293
  196.  
  197.          Difference (hexadecimal)      FFE2           0125
  198.  
  199.     Thus,  for the first mail archive created on a Wednesday, the
  200.     archive would be named "FFE20125.WE1".
  201.  
  202.  
  203.  
  204.     The name of the mail packets generated and stored in  a  mail
  205.     archive is:
  206.  
  207.          ddhhmmss.PKT
  208.  
  209.     where:
  210.  
  211.          dd  ==  Day of month when packet was created
  212.          hh  ==  Hour of day when packet was created
  213.          mm  ==  Minutes past the hour
  214.          ss  ==  Seconds past the minute
  215.  
  216.  
  217.     These  naming conventions are intended to allow mail archives
  218.     to queue up, preventing loss of mail in the event that a mail
  219.     archive is not sent or processed in a timely fashion.
  220.  
  221.  
  222.                               * * * * *
  223.  
  224.     Automatic cleanup:
  225.     ------------------
  226.  
  227.     ARCmail always deletes an archive that it unpacks mail  from.
  228.     In  addition,  when it is creating a mail archive for another
  229.     node,  it checks to see if the previous mail archive to  that
  230.     address  has been sent.  If so,  it deletes the outbound mail
  231.     archive and creates a new one.  If not,  then the  additional
  232.     outbound mail is added to the previous (pending) archive.
  233.  
  234. |   When ARCmail is asked to archive mail to a node that  it  has
  235. |   no  pending  mail for,  it checks to see if any previous mail
  236. |   archive to that node exists and has already been sent.  If an
  237. |   earlier archive has not  yet  been  sent,  then  it  is  left
  238. |   untouched.  Otherwise,  the  old  mail archive is set to zero
  239. |   length so as not to consume disk space (this can  be  changed
  240. |   by  the  /R  switch).  The  old  archive  is retained so that
  241. |   ARCmail will "remember" the  name  and  number  of  the  last
  242. |   archive sent.
  243.  
  244.     ARCmail  performs  all  of  the usual cleanup associated with
  245.     sending messages.  Messages marked as "kill  when  sent"  are
  246.     deleted  once  they  have  been  packed in an archive.  Other
  247.     messages are marked as "sent" when  they  are  archived.  The
  248.     act  of placing a message in a mail archive is considered the
  249.     same as sending the message,  regardless of whether the  mail
  250.     archive is ever sent.
  251.  
  252.     It  is  not  necessary  to  create a message sending the mail
  253.     archive to its destination.  ARCmail does this automatically.
  254.  
  255.  
  256.                               * * * * *
  257.  
  258.     Option switches:
  259.     ----------------
  260.  
  261.     How ARCmail operates may be modified by the  use  of  various
  262.     option  switches.  These switches begin with either a dash or
  263.     a slash, and may be placed anywhere on the command line.  The
  264.     available switches are:
  265.  
  266.          /C        Indicates that crash priority messages  should
  267.                    be archived, and causes the attach message (if
  268.                    created) to be marked crash priority.
  269.  
  270.          /H        Causes  the  attach message (if created) to be
  271.                    marked "Hold for pickup."
  272.  
  273.          /F        Indicates that messages  with  attached  files
  274.                    should  be  archived.  The attached files will
  275.                    NOT be archived, and will NOT be sent.
  276.  
  277. |        /R        Indicates  that  mail in archives already sent
  278. |                  should be retained.  Archives already sent are
  279. |                  normally set to  zero  length  so  as  not  to
  280. |                  consume  disk  space.  This  option  overrides
  281. |                  that.
  282.  
  283.          /G<word>  Indicates that  ARC  should  be  told  to  use
  284.                    archive  encryption/decryption using the given
  285.                    password.
  286.  
  287. |   Note that the /C, /H, /F, and /R switches are only meaningful
  288.     for "ARCmail TO".  The /G  option  is  meaningful  in  either
  289.     case, but if if a matching encryption password is not used at
  290.     both  ends  of  the  transfer,  then the mail will be forever
  291.     lost.
  292.  
  293.  
  294.                               * * * * *
  295.  
  296.     Caveat emptor:
  297.     --------------
  298.  
  299. |   ARCmail 0.60 is a prototype of an  eventual  SEAdog  utility,
  300.     which  is being released as a favor to the FidoNet community.
  301.     As such, we accept no responsibility for anything that may or
  302.     may not  happen  as  a  result  of  using  ARCmail.  You  are
  303.     strictly on your own.
  304.  
  305.     In  its present form,  ARCmail has several shortcomings.  The
  306.     most important is that it does not understand routing in  any
  307.     way.  Only  those  messages which are explicitly addressed to
  308.     the destination are packed in the mail archive,  and all such
  309.     messages are packed regardless of their source.
  310.  
  311.     ARCmail should not be used to generate multiple mail archives
  312.     to the same destination more than 10 times per day.
  313.  
  314.     ARCmail  requires  the  use of ARC.EXE which must reside in a
  315.     PATHed directory, and which has a minimum storage requirement
  316.     of approximately 200K.
  317.  
  318.     We do not promise that we will  ever  develop  this  concept
  319.     beyond this initial prototype version.
  320.  
  321.  
  322.                               * * * * *
  323.  
  324.     Release History:
  325.     ----------------
  326.  
  327.     Version 0.29 - 06/04/86  Original  version  of  ARCmail which
  328.                              was used within Net 107 only.
  329.  
  330.     Version 0.30 - 06/05/86  First version of  ARCmail  that  was
  331.                              released for use outside of Net 107.
  332.  
  333.     Version 0.31 - 06/13/86  Corrected  an  error  in  logic that
  334.                              prevented  ARCmail  from   unpacking
  335.                              multiple  files  received  from  the
  336.                              same sender.
  337.  
  338.     Version 0.35 - 06/16/86  Changed the naming  scheme  for  the
  339.                              ARCmail  file  to  allow the user to
  340.                              send as many as ten ARCmail files to
  341.                              the same receiver  during  the  same
  342.                              day.
  343.  
  344.                              Changed  the  format  of the console
  345.                              status  messages  to  a  form   more
  346.                              suitable  for  creating  a  log when
  347.                              redirecting output to a file.
  348.  
  349.     Version 0.36 - 06/17/86  Inserted  logic   to   detect   when
  350.                              COMMAND.COM  could  not be loaded to
  351.                              run ARC.
  352.  
  353.                              Added seconds  to  the  mail  packet
  354.                              name.
  355.  
  356.                              Added the FROM WHO option.
  357.  
  358.     Version 0.40 - 07/25/86  Added  logic  to  add new packets to
  359.                              pending archives instead of creating
  360.                              new archives, thus preventing excess
  361.                              archive proliferation.
  362.  
  363.                              Added    additional    checks    for
  364.                              COMMAND.COM load failure.
  365.  
  366.                              Added the TO WHO option.
  367.  
  368.     Version 0.50 - 10/10/86  Added  logic to pack and unpack mail
  369.                              for multiple addresses.
  370.  
  371.                              Added the /F and /G switches.
  372.  
  373.                              Improved detection  of  cases  where
  374.                              ARC  is  not  loaded or is unable to
  375.                              run, and added error recovery code.
  376.  
  377.                              Added logic to set  error  level  to
  378.                              the number of mail archives detected
  379.                              during a "who".
  380.  
  381. |   Version 0.60 - 12/2/86   Added the /R switch.
  382.  
  383. |                            Added the FROM ALL and TO LIST
  384. |                            functions.
  385.